home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 51 / Amiga Format CD51 (2000-03-10)(Future Publishing)(GB)[!][issue 2000-04].iso / -in_the_mag- / pdselect / awnp / awnp-docs / window.doc < prev   
Text File  |  2000-02-16  |  5KB  |  213 lines

  1. The parameters defining the CA window must all be on one line terminated by a newline. The pipe will reply with 'window ok'.
  2.  
  3.  
  4. screentitle="screen title text"  (st=)
  5.  
  6.  Set the text for the screen title when CA window is active.
  7.  
  8. title="window title text"
  9.  
  10.  Set the title for the CA window.
  11.  
  12. pubscreen="Screen name"  (ps=)
  13.  
  14.  Open the CA window on a public screen
  15.  
  16. IconifyIcon (ii=)
  17.  
  18. Set the name of the icon to use when you iconify the window.
  19.  
  20. IconTitle="icon title text"  (it=)
  21.  
  22.  Set the title for the CA window when iconified.
  23.  
  24. backfill="filename"  (bf=)
  25.  
  26.  Image file to use as backfill for window. If backfill is not specified you get the default window backfill. Setting backfill="" can be used to have no backfill at all. Use this carefully as it overides the user CA prefs.
  27.  
  28. NoBorder (NB)
  29.  
  30.  Make the window borderless.
  31.  
  32. Quiet  (q)
  33.  
  34.  Tell the pipe not to reply to the window, gadget definitions, or modify commands. This is actually a toggle switch turning replies off and on. SOME modify commands are ALWAYS replied to. (addnode and getfile selected 0|1)
  35.  
  36. NoWindow
  37.  
  38.  switch to causes no window to be opened. This will not work unless modify is set and an arexx object is defined.
  39.  
  40. app
  41.  
  42.  Make  this  window a application window.
  43.  
  44. activate  (a)
  45.  
  46.  Switch to activate theCA window when it opens.
  47.  
  48. depthgadget (dg)
  49.  
  50.  Switch to include a depth gadget on the CA window.
  51.  
  52. dragbar  (db)
  53.  
  54.  Switch to include a drag bar on the CA window.
  55.  
  56. closegadget (cg)
  57.  
  58.  Switch to include a close gadget on the CA window.
  59.  
  60. sizegadget (sg)
  61.  
  62.  Switch to include a window size gadget on the CA window.
  63.  
  64. iconifygadget  (ig)
  65.  
  66.  Switch to include an iconify gadget on the CA window.
  67.  
  68. fullscreen    (fs)
  69. centerscreen   (cs)
  70. topleft         (tl)
  71.  
  72.  Relative position to open the CA window at. Defaults to centermouse.
  73.  
  74. top=number
  75. left=number
  76. width=umber
  77. height=number
  78.  
  79.  Position and size to open  the CA window. Using the left parameter over rides the relative positioning above.
  80.  
  81. vertical     (v)
  82.  
  83.  Switch to display gadgets vertically, defaults to horizontal.
  84.  
  85. even    (e)
  86.  
  87.  Switch to make gadgets/groups all the same size.
  88.  
  89. defaultgadgets  (defg)
  90.  
  91.  Switch to include close, depth, size, and drag gadgets on the CA window.
  92.  
  93. sendkeys  (sk)
  94.  
  95.  Switch to have the CA window return keystrokes.
  96.  
  97. sendqual  (sq)
  98.  
  99.  Switch to have the CA window send qualifier events. (see events.doc)
  100.  
  101. modify   (m)
  102.  
  103.  Switch to allow the CA window to be modified AFTER it has been opened.
  104. (See modify parameters below)
  105.  
  106. help (h)
  107.  
  108.   Switch to have the CA window return help events.
  109.  
  110. state
  111.  
  112. Switch to have the CA window return active/inactive events.
  113.  
  114. refresh
  115.  
  116. Switch to have the CA window return refresh events. This is only useful if you are doing your rendering directly into the window.
  117.  
  118. defer
  119.  
  120.  Switch to defer window layout from the input device to the pipe task. This will make input.device more responsive, and drop the (possibly quite heavy)process of recalculating the display to normal application priority instead of the priority 20 of input.device.
  121.  
  122.  It also means window refresh is blocked if you are sending modify commands to the pipe. The window refreshes AFTER you send 'continue'.
  123.  
  124. SpaceOuter (so)
  125.  
  126.  Leave a blank space outside the  root layout of the CA window.
  127.  
  128. SpaceInner  (si)
  129.  
  130.  Leave a blank space around elements in the root layout of the CA window.
  131.  
  132. fixwidth (fw)
  133.  
  134.  Do not allow the width of the window to be adjusted.
  135.  
  136. fixheight (fh)
  137.  
  138.  Do not allow the width of the window to be adjusted.
  139.  
  140. shrinkwrap (sw)
  141.  
  142.  Keep all gadgets in the window as close together as possible.
  143.  
  144. specialchar="character" (sc=)
  145.  
  146.  'Character' is a single character that replaces '|', in use as a seperator inside parameters like chooserlabels, tags, penmapdata, ...
  147.  
  148. tags="tags|data[|tag|data...]|0
  149.  
  150.  A list of tag and value pairs in HEX. Do not forget the trailing null !
  151.  
  152. info
  153.  
  154.  Include the drawinfo pen array for the screen in the reply to the window definition line.
  155.  
  156.  If successful the reply is
  157.  
  158. 'ok window NUMBERofPENS PEN0 PEN1 ...'
  159.  
  160. see include:intuition/screen.h for more about drawinfo pens.
  161.  
  162.  
  163. Modify GID 0
  164. ------------
  165.  
  166. GID 0 is used to specify the GUI window itself. It can be used in modify lines to control certain aspects of the window.
  167.  
  168. selected=function_bitmap (s=)
  169. This should really have been in HEX but its not for backward compatability.
  170.  
  171. bit# decimal function
  172.  
  173. 0       1      activate window
  174. 1       2      window to front
  175. 2       4      window to back
  176. 3       8      set window title
  177. 4      16      set screen title
  178. 5      32      iconify window
  179. 6      64      uniconify (or open) window
  180. 7     128      Close window (but do not dispose)
  181. 8     256      Set busy pointer and disable window
  182. 9     512      Clear busy pointer and enable window
  183.  
  184. You can use more than one functionat the same time. 66=uniconify and windowtofront.
  185.  
  186. gadgettext=  (gt=)
  187.  
  188.  Text for setting screen or window title.
  189.  
  190. disable=BOOL  (dis=)
  191.  
  192.  0 enables all gadgets in window.
  193.  1 disables all gadgets
  194.  
  195. wide=num
  196. high=num
  197.  
  198.  Attempt to resize the window to the given width and/or height.Set wide=1 high=1 to get the minimum size possible.
  199.  
  200. top=num
  201. left=num
  202.  
  203.  Move the window to the given position(s).
  204.  
  205. 'ID 0 read'
  206. returns the windows 'left top width height' settings. (width and height report as 0 until you get at least 1 event back from the
  207. pipe)
  208.  
  209. refresh (ref)
  210.  
  211.  Refresh all gadgets in the window.
  212.  
  213.